Improve versioning error messages, return NotFound gRPC error for all not found errors #8641
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Conflicts: # proto/internal/temporal/server/api/deployment/v1/message.proto # tests/versioning_3_test.go
… not found errors
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Bug: Ramping crashes on empty version configuration
In SetRampingVersion, when version is empty (unsetting ramping) and allowNoPollers is true, versionObj is nil. Calling versionObj.GetBuildId() at line 800 in updateWithStartWorkerDeployment causes a nil pointer dereference. The code should check if versionObj is nil before dereferencing or handle empty version specially.
service/worker/workerdeployment/client.go#L792-L803
temporal/service/worker/workerdeployment/client.go
Lines 792 to 803 in d572f69
ShahabT
approved these changes
Nov 22, 2025
Shivs11
added a commit
that referenced
this pull request
Nov 26, 2025
… not found errors (#8641) ## What changed? Improve versioning error messages, return NotFound gRPC error for all not found errors ## Why? So that users can see if they mispelled a deployment name or build id, and generally know which versions are involved when there is an error ## How did you test it? - [ ] built - [ ] run locally and tested manually - [x] covered by existing tests - [ ] added new unit test(s) - [ ] added new functional test(s) ## Potential risks Changing the error returned only affected replay if the type of error changes, not the string. I am keeping the type the same in the few places where I had to change the error string, so it won't affect workflow replay. Error messages are not compared when checking order of commands in workflow replay check in Go SDK here: https://github.com/temporalio/sdk-go/blob/ad990a3bfe17560c82cf84c80dfdf6c41eb43580/internal/internal_task_handlers.go#L1616 <!-- CURSOR_SUMMARY --> --- > [!NOTE] > Standardizes NotFound errors and makes worker deployment/version errors more informative (include deployment/build IDs), with corresponding workflow validations and test updates. > > - **Worker Deployment (server)**: > - **Error Semantics**: Use `NotFound` for missing deployments/versions (e.g., `ErrWorkerDeploymentNotFound`, `ErrWorkerDeploymentVersionNotFound`), replacing prior `FailedPrecondition` in those cases. > - **Richer Messages**: Parameterize errors with deployment/version info (`build_id`, deployment name); add formatted messages for draining/has-pollers/current-or-ramping; introduce suffix constants and string matching to map workflow failures to precise non-retryable errors. > - **APIs Affected**: `SetCurrentVersion`, `SetRampingVersion`, `DescribeVersion`, `DeleteVersionFromWorkerDeployment`, and update handling (`handleUpdateVersionFailures`). > - **Validation Updates (workflow)**: Return `FailedPreconditionf` with version details for missing task queues, manager identity mismatch, and current/ramping delete checks. > - **Tests**: > - Adjust expectations to new `NotFound` usage and formatted messages; update assertions to use `FailedPreconditionf` message strings. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 5bb0b22. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY --> --------- Co-authored-by: Shivam Saraf <[email protected]> Co-authored-by: ShahabT <[email protected]>
lina-temporal
pushed a commit
that referenced
this pull request
Nov 26, 2025
… not found errors (#8641) ## What changed? Improve versioning error messages, return NotFound gRPC error for all not found errors ## Why? So that users can see if they mispelled a deployment name or build id, and generally know which versions are involved when there is an error ## How did you test it? - [ ] built - [ ] run locally and tested manually - [x] covered by existing tests - [ ] added new unit test(s) - [ ] added new functional test(s) ## Potential risks Changing the error returned only affected replay if the type of error changes, not the string. I am keeping the type the same in the few places where I had to change the error string, so it won't affect workflow replay. Error messages are not compared when checking order of commands in workflow replay check in Go SDK here: https://github.com/temporalio/sdk-go/blob/ad990a3bfe17560c82cf84c80dfdf6c41eb43580/internal/internal_task_handlers.go#L1616 <!-- CURSOR_SUMMARY --> --- > [!NOTE] > Standardizes NotFound errors and makes worker deployment/version errors more informative (include deployment/build IDs), with corresponding workflow validations and test updates. > > - **Worker Deployment (server)**: > - **Error Semantics**: Use `NotFound` for missing deployments/versions (e.g., `ErrWorkerDeploymentNotFound`, `ErrWorkerDeploymentVersionNotFound`), replacing prior `FailedPrecondition` in those cases. > - **Richer Messages**: Parameterize errors with deployment/version info (`build_id`, deployment name); add formatted messages for draining/has-pollers/current-or-ramping; introduce suffix constants and string matching to map workflow failures to precise non-retryable errors. > - **APIs Affected**: `SetCurrentVersion`, `SetRampingVersion`, `DescribeVersion`, `DeleteVersionFromWorkerDeployment`, and update handling (`handleUpdateVersionFailures`). > - **Validation Updates (workflow)**: Return `FailedPreconditionf` with version details for missing task queues, manager identity mismatch, and current/ramping delete checks. > - **Tests**: > - Adjust expectations to new `NotFound` usage and formatted messages; update assertions to use `FailedPreconditionf` message strings. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 5bb0b22. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY --> --------- Co-authored-by: Shivam Saraf <[email protected]> Co-authored-by: ShahabT <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changed?
Improve versioning error messages, return NotFound gRPC error for all not found errors
Why?
So that users can see if they mispelled a deployment name or build id, and generally know which versions are involved when there is an error
How did you test it?
Potential risks
Changing the error returned only affected replay if the type of error changes, not the string. I am keeping the type the same in the few places where I had to change the error string, so it won't affect workflow replay.
Error messages are not compared when checking order of commands in workflow replay check in Go SDK here: https://github.com/temporalio/sdk-go/blob/ad990a3bfe17560c82cf84c80dfdf6c41eb43580/internal/internal_task_handlers.go#L1616
Note
Standardizes NotFound errors and makes worker deployment/version errors more informative (include deployment/build IDs), with corresponding workflow validations and test updates.
NotFoundfor missing deployments/versions (e.g.,ErrWorkerDeploymentNotFound,ErrWorkerDeploymentVersionNotFound), replacing priorFailedPreconditionin those cases.build_id, deployment name); add formatted messages for draining/has-pollers/current-or-ramping; introduce suffix constants and string matching to map workflow failures to precise non-retryable errors.SetCurrentVersion,SetRampingVersion,DescribeVersion,DeleteVersionFromWorkerDeployment, and update handling (handleUpdateVersionFailures).FailedPreconditionfwith version details for missing task queues, manager identity mismatch, and current/ramping delete checks.NotFoundusage and formatted messages; update assertions to useFailedPreconditionfmessage strings.Written by Cursor Bugbot for commit 5bb0b22. This will update automatically on new commits. Configure here.